Bundle org.nuxeo.template.manager.xdocreport
Documentation
-
ReadMe.md
This modules contains [XDocReport http://code.google.com/p/xdocreport/] plugins of nuxexo-template-rendering module.
TemplateProcessor
XDocReportProcessor provides an implemantation of the TemplateProcessor that uses XDocReport as an engine.
Supported formats
This template processor supports several formats :
- OpenOffice ODT (Write)
- OpenOffice ODS (Calc)
- MS Office docx (Word)
Supported features
- merge fields
- loops on fields
- picture insertion
- text formatting and content inclusion
Templating format
See [XDocReport documentation http://code.google.com/p/xdocreport/wiki/DesignReport].
XDocReport Remoting
This module also contains a WebEngine JAX-RS module to provide experimental support for XDocReport remoting and tooling.
XDocReportTools and REST bindings
XDocReport provide an OpenOffice addon that help the design of Templates. This is still an early version, but you can however use it with Nuxeo.
The field definition XML file can be generated from Nuxeo Rest API. The field definition file can be generate on a per document type basis :
http://server:port/nuxeo/site/xdoctemplates/xdocresources/model/{docType}
For XDocReport Resource remote service you can use :
http://server:post/nuxeo/site/xdoctemplates/xdocresources
-
Parent Documentation: ReadMe.md
Nuxeo Template Rendering
About Nuxeo Template Rendering
The Nuxeo Template Rendering is a set of plugins that provides a way to associate a Nuxeo Document with a Template. The Templates are used to render the associated document. Depending on the Template type, a different Template Processor will be used and the resulting rendering can be :
- an HTML document
- an XML document
- an OpenOffice document
- an MS Office document
Each template processor has his own logic for rendering a Document from a Template :
- raw processing (FreeMarker or XSLT)
- merge fields replacement (MS Office / OpenOffice)
This project is an on-going project, supported by Nuxeo.
Sub-modules organization
The project is splitted in several sub modules :
nuxeo-template-rendering-api
API module containing all interfaces.
nuxeo-template-rendering-core
Component, extension points and service implementation. This modules only contains template processors for FreeMarker and XSLT.
nuxeo-template-rendering-jsf
Contribute UI level extensions: Layouts, Widgets, Views, Url bindings ...
nuxeo-template-rendering-xdocreport
Contribute the OpenOffice / DocX processor based on XDocReport. This is by far the most powerfull processor. See: http://code.google.com/p/xdocreport/
nuxeo-template-rendering-jxls
Contribute a template processor for XLS files based on JXLS project. See: http://jxls.sourceforge.net/
nuxeo-template-rendering-jod
Contribute JOD Report based template processor for ODT files. This renderer is historical and replaced by xdocreport that is more powerful.
nuxeo-template-rendering-jaxrs
Contribute a JAXRS simple API as well as a new WebTemplate doc type that is based on a Note rather than a file.
nuxeo-template-rendering-sandbox
Misc code and extensions that are currently experimental.
nuxeo-template-rendering-package
Builder for marketplace package.
Building
How to build Nuxeo Template Rendering
Build the Nuxeo Template Rendering add-on with Maven:
mvn clean installDeploying
Nuxeo Template Rendering is available as a package add-on [from the Nuxeo Marketplace] (https://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-template-rendering)
Resources
Documentation
The documentation for Nuxeo Template Rendering is available in our Documentation Center: http://doc.nuxeo.com/x/9YSo
Reporting Issues
You can follow the developments in the Nuxeo Platform project of our JIRA bug tracker, which includes a Template Rendering component: https://jira.nuxeo.com/browse/NXP/component/11405
You can report issues on: http://answers.nuxeo.com/
About Nuxeo
Nuxeo dramatically improves how content-based applications are built, managed and deployed, making customers more agile, innovative and successful. Nuxeo provides a next generation, enterprise ready platform for building traditional and cutting-edge content oriented applications. Combining a powerful application development environment with SaaS-based tools and a modular architecture, the Nuxeo Platform and Products provide clear business value to some of the most recognizable brands including Verizon, Electronic Arts, Sharp, FICO, the U.S. Navy, and Boeing. Nuxeo is headquartered in New York and Paris. More information is available at www.nuxeo.com.
Resolution Order
You can influence this order by adding "require" tags in the component declaration, to make sure it is resolved after another component. It will also impact the order in which contributions are registered on their target extension point (see "Registration Order" on contributions).
Components
Packages
Maven Artifact
| File | nuxeo-template-rendering-xdocreport-2023.10.13.jar |
|---|---|
| Group Id | org.nuxeo.template.rendering |
| Artifact Id | nuxeo-template-rendering-xdocreport |
| Version | 2023.10.13 |
Manifest
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven 3.9.6
Built-By: root
Build-Jdk: 17.0.10
Bundle-ManifestVersion: 1
Bundle-Version: 1.0.0
Bundle-Name: Nuxeo ECM Document template Manager XDocreport plugin
Bundle-SymbolicName: org.nuxeo.template.manager.xdocreport;singleton:=tr
ue
Nuxeo-WebModule: org.nuxeo.template.xdocreport.jaxrs.JAXRSRemotingApplic
ation;name=XDocTemplateResources
Nuxeo-Component: OSGI-INF/templateprocessor-contrib.xml
Exports
- Json Export Default Json serialization
- Json Graph Json dependency graph
- Json Contribution Stats Json statistics for contributions
- CSV Contribution Stats CSV statistics for contributions
Charts
-
Raw Data: Json Contribution Stats